<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- Description	: Userguide for Rocket Analysis Tool-->
<!-- Author		: RAT	 -->
<!-- Date		: 24/10/2006 -->
<head>
	<title>Userguide for Rocket Analysis Tool</title>
	<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
	<meta name="author" content="Shammika Munugoda" />
	<meta name="description" content="Home page of the web site" />
	<meta name="keywords" content="style.css" />
	<link rel="stylesheet" title="Default" type="text/css" href="style.css" />
</head>

<body>

<div id="index">
	<div id="indexinner">
		<h2 align="centre">User Guide For Rocket Analysis Tool(RAT).</h2>
		<p class="displaytext">Developed by Team Rocket</p>
		<div id="info">
			<h3>Introduction</h3>
			<p><strong>Rocket Analysis Tool</strong> is an automated tool for measuring various metrics, related to a project.
			Based on those metrics,you can make valuble decisions on the current project.
			</p>
			
			<p class="displaytext">Some of the metrics that RAT measures are as follows.</p>
			<ul>
			<li>Fan-In count - Relative & Cumalative
			<li>Fan-Out count - Relative & Cumalative
			<li>Size measures for a particular version of the project
				<ul>
					<li>Number of classes
					<li>Number of methods
					<li>Number of packages
					<li>Byte code size
				</ul>
			</ul>
			
			<li>Download the latest version of RAT from <a href="http://rat-rocket-analysis-tool.googlecode.com/svn/trunk/rat.zip">here</a></ul>
		</div>

		<div id="pre">
			<h3>Pre-requisites for RAT</h3>

			<p class="displaytext">Hardware/Software Requirements</p>
			<ul>Supported Operating Systems
			<li>Microsoft Windows XP

			<li>Microsoft Windows Vista RC1

			<li>Linux

			<li>Mac OSX (10.*)
			</ul>

			<ul>		Hardware Requirements
			<li>         PC with 256 MB of RAM and  1.5Ghz or greater processor

			<li>         Requires a Disk space of: 1MB
			</ul>
			
			<p class="displaytext">Software Requirements</p>
			<ul><li>Java Runtime Environment 5.0</li>

			
		</div>
		
		<div id="howto">
			<h3>How to use RAT</h3>
			<p class="displaytext">To execute RAT simply double click the batch file rat.bat</p>
			<p class="displaytext"> From the initial screen the user can </p>
				<ol><li>Create a new project
				<li>Open an existing project
				<li>Exit from RAT
				</li></li></li></ol>
				<br />
				
				<b>1. </b>Create a new project<br /><br />
				<blockquote>
				<i>Create the project</i>
				<blockquote>The user will have to enter a name for the RAT project,Start date of the project(optional),a short 
				description of the project(optional).
				A new XML file(&lt;projectname&gt;.xml) will be created under the relative path of RAT. The location of the newly created XML file will be notified to the user.
				<br />
				</blockquote>
				
				<i>Add version of data to the created project</i>
				<blockquote>
					For every build of the project a UNIQUE version number needs to be entered.This version identifier would ideally be any numeric value,such as 1,2..or 0.14,0.34...etc.<br />
					A release date of the format dd/mm/yyyy for the given version needs to be entered.
					<br />
					Then enter a class file or a JAR file you need to analyse.Please note that the full path needs to be given here.
					<br /><br />eg :- C:\RAT\jarfiles\JFreeChart.jar
					<br /><br />Once the file has been read by RAT,it automatically analyses the class files which are in the jar file.
					<br /><br />Then the user will be prompted if he needs to enter anymore class/JAR files or not
					<br /><br />If the user wants he can enter another version for the current project as well.
					
				</blockquote>
				
				<i><a id="charts">Use Relative or Cumalative histogram types.</a></i>
				<blockquote>
					<p>The user can either select the RAT to generate relative histograms or cumalative histograms for the whole project.So all the interactions from this point onwards will be based on the user's selection of the histogram type.
				</blockquote>
				
				<i>Generate Charts</i>
				<blockquote>
					<p>Three types of charts can be generated
					<ul><li>Growth charts - eg:- number of classes,number of methods...etc
					<li>Fan-In histogram
					<li>Fan-Out histogram
					</ul>
					And follow the descriptive prompts,which accepts different parameters for generating the charts.
				</blockquote>
	</blockquote>
	<b>2. </b>Open project<br /><br />
	<blockquote>
				<i>Create the project</i>
				<blockquote>
					<p>Please enter the location of the xml file of the project you want to analyse.
					<br /><br />
					Enter the absolute path of the XML file.
					<br />
					eg:- C:\Documents and Settings\Shammika Munugoda\Desktop\RAT\projects\RAT\RAT.xml
					<br /><br />The rest of the user interaction is similar to the generation of the histograms & charts. <a href="#charts">eg</a>
					
					</p>
				</blockquote>
	</blockquote>
	
	<b>3. </b>Exit<br /><br />
		<blockquote><i>Simply exits from RAT</blockquote>
	</div>

		

</div>
</body>
</html>